Configurable Functionality

You can configure editable fields in ontrack Designer and match those fields to call the appropriate REST service to update the record for standard controls.

Note: This functionality is controlled by the OntrackWriteback licence for ebs: ontrack Hub and the OntrackProspectWrite licence for ebs: ontrack Learner Hub. If the relevant licence is not enabled, the Service and Web Service Field fields are greyed out on the Control Details and Column Details panes respectively.

To configure write-back fields:

1. Copy the required page.

2. In the Page Details pane, select the relevant standard control.

   

3. In the Control Details pane, select the required REST service from the list of available services in the Service drop-down field.

   

4. In the Page Details pane, select the text field you want to configure.

   

5. In the Column Details pane, complete the following fields:
   1. In the Web Service Field field, select the REST service field from the drop-down list to match with the editable field.
   2. Select the Editable check box.
   3. Select the Required check box.

   4. In the Min Length field, enter the minimum number of characters allowed in the field.

      Note: The maximum length is limited to the maximum length accepted by the REST service. The Max Length field can be used to restrict it further if necessary.

      

      Note: You can also configure invisible fields to send to the REST service that it might require, by deselecting all the visible flags, and selecting the Always Send to Web Service check box.

6. Click Save.

   The configured text field can then be edited in ebs: ontrack Hub or ebs: ontrack Learner Hub and any updates to the field will call the appropriate REST service.

   

Back to top

You can create pages in ontrack Designer so staff and learners can create or update or delete custom log records in ebs: ontrack Hub and ebs: ontrack Learner Hub.

To configure a page to create or update or delete custom log records, you can select one of the following new REST services from the Service field in the Control Details pane:

• Create or Update User Table Records
• Delete User Table Records

The User Table field is displayed when one of the REST services above is selected, from which users can select the required user table to write-back to.

Note: Custom write-back is restricted to custom log tables only, and it is not possible to write-back directly to other base tables (for example: PEOPLE).

Permissions to use the REST services to manage records for other users requires the associated custom user roles assigned.

Note: A validation message is displayed if there are issues with a user's request to create or update or delete custom log records.

An authenticated user (for example: learner) requires no permissions to create a new record linked to themselves and can edit and/or delete a record they have created.

The following example shows a set of screens that have been built upon a user table created for the Organisation Log that is used to capture change requests (that is: to enable staff to request changes to data, rather than change live data directly).

A staff user can request a change to prospectus information on a course in ebs: ontrack Hub.

This request can then be viewed by another staff user (for example: senior manager) with the required custom user roles associated, and authorised or rejected as required.

Details of the request and any subsequent changes will update the relevant custom log record in ebs: central.

Refer to Custom Logs for further information on managing custom logs.

Back to top

You can audit pages that a user visits in ebs: ontrack Hub and ebs: ontrack Learner Hub to assist with data protection compliance.

When a valid OnAccessAudit licence is held, the Audit Access check box is displayed for each page in ebs: ontrack Designer. If the Allow all ontrack hub/prospect access? institution settings are set to Y, this will set the Audit Access check box to ticked and make it read-only at page level, with the audit information stored in the database whenever a page is visited.

Note: The information stored includes the URL and/or parameter information so that it is possible to identify exactly what page the user looked at, plus any contextual information (for example: if the Learner Details page was visited, the person code of the learner is included in the stored information).

If the Allow all ontrack hub/prospect access? institution settings are set to N, the Audit Access check box is not selected but can be edited to allow individual page auditing access.

The following validation also applies to the audit data when it is stored:

• The learner export process (accessed from the Learner Export button in the Learner module) includes any audit data
• The de-duplication process transfers any audit data between learner records
• The learner deletion process deletes any associated audit data (that is: existence of this data will not prevent deletion)

Back to top

You can configure pages to collect information for a record and then submit the data entered (for example: this can be used to write-back to the appropriate Delete REST service to delete a record using a submit button).

To configure pages to be able to submit data:

1. Copy the required page.

2. In the Page Details pane, select the required control, and then click the Add Button button on the System Configuration Commands ribbon.

   

   The button is added to the selected control.

   

3. In the Column Details pane, complete the following fields:
   1. Select the Is Submit check box.
   2. In the Route field, enter RestServiceWriteBack.
   3. In the Action field, enter ProcessData for the page.
   4. In the Display Text field, enter the required name for the button.

   5. Select the Suppress message on success check box to not display a confirmation message for a submit option after a successful action.

   6. In the Confirmation Message field, enter the required text for the confirmation message that displays.

   

4. Click Save.

   The information entered on the configured page will be saved on clicking the submit button.

Back to top

You can configure pages to collect information for a record over multiple pages and then submit the data entered. This configuration is useful to control which fields are displayed for different scenarios (for example: when collecting enrolment information, there may be a different set of fields required for a full-time course compared to a part-time course).

To configure this functionality:

1. Copy the required page.
2. In the Page Layout Details pane, complete the following fields:
   1. In the Flow Key field, enter the same value for each page.
   2. In the Sequence field, enter the required order for each page.

   

3. In the Page Details pane, select the button to navigate to the next page.

   

4. In the Column Details pane, complete the following fields:
   1. In the Route field, enter RestServiceWriteBack.
   2. In the Action field, enter Navigate for each page other than the final page and ProcessData for the final page in the sequence.

   

5. In the Navigation Link field, select Link to another screen from the drop-down list.

   

6. Click Save.

   The information entered on the configured pages will be submitted on completion of the final page.

Back to top

You can control editable access to data for users (that is: restrict the editing of data to appropriate users) in ontrack Designer.

The Edit Lockdown Column field is available on the Control Details pane.

This field is populated by the columns available in the data link specified in the Data field that are prefixed by 'ISEDITABLE_'.

If the data returned in this column is set to N, then the control is read-only in ebs: ontrack Hub or ebs: ontrack Learner Hub. Any other value, including null will make the control editable.

Note: You can also disable editing at row level by linking a grid column to the ISEDITABLE flag (that is: when an editable column has the edit lockdown column set, then the same logic applied by this setting that is used in the standard control is applied to the grid on a row by row basis).

Back to top

You can embed website analytics tracking code into each page in ebs: ontrack Hub or ebs: ontrack Learner Hub. This will allow users to track website usage and user behaviours using third party tools (for example: Google Analytics or Google Tag Manager).

To embed analytics code into the website, there is a folder '~/Views/Analytics' contained in the site location in which any scripts must be placed. These scripts must be in .cshtml file format.

Back to top

You can embed language translation tools (for example: Google Translate) into each page in ebs: ontrack Hub or ebs: ontrack Learner Hub so the website can be viewed in different languages.

To embed language translation tools, there is a readme.txt file stored in the Translation folder in the following file location explaining how to create a .cshtml file for the required languages to translate:

• C:\Program Files\Tribal\[Install Location]\ebs4\OntrackLearner\Views\Translation

When the language translation tool is embedded into the relevant website, the Select Language option is located in the bottom left-hand corner of the navigation pane from which users can select the required language.

Back to top

The following web config settings are available so you can change the 'ebs: ontrack' and 'Tribal' logo images on the login page:

• productImageLocation - use to change the 'ebs: ontrack' logo
• organisationImageLocation - use to change the 'Tribal' logo

Note: The '$homepage-background-image' scss variable also allows the default background image to be overridden on the login page.

Back to top

The Find a Course section can be made available on the Homepage in ebs: ontrack Learner Hub so learners can search for a course to find out more details and add courses to their basket where they can enrol (that is: if your institution does not have a prospectus on their website, learners can search for and enrol on courses using this process).

Note: This section is not displayed by default so the visibility needs to be enabled in ontrack Designer.

Back to top

You can insert radio buttons into ontrack software using ebs: ontrack Hub Designer and ebs: ontrack Learner Hub Designer.

To configure a radio button, the following are required:

• A data link is required to be created on the page which includes the data that you want to select from. Refer to Add data links for further information

• A column with a Data type of the specified data link, and a Type of 'RadioButton' is also required.

  Note: The Is Static Text check box must be deselected for the Data field to be displayed.

Any verifiers or any code that generates as a list can be used.

An example datalink for a radio button is displayed in the following image.

An example of the Radio buttons displayed in ebs: ontrack Hub.

Back to top